home *** CD-ROM | disk | FTP | other *** search
/ PC Advisor 2011 May / PC Advisor 190 E.iso / pc / ESSENTIALS / VLC Media Player 1.1 / vlc-1.1.5-win32.exe / sdk / include / vlc / plugins / vlc_demux.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-11-13  |  8.2 KB  |  219 lines
  1. /*****************************************************************************
  2.  * vlc_demux.h: Demuxer descriptor, queries and methods
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2005 the VideoLAN team
  5.  * $Id: 38351b88dc3f99cce1abffdbec9e9b622005c592 $
  6.  *
  7.  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_DEMUX_H
  25. #define VLC_DEMUX_H 1
  26.  
  27. /**
  28.  * \file
  29.  * This files defines functions and structures used by demux objects in vlc
  30.  */
  31.  
  32. #include <vlc_es.h>
  33. #include <vlc_stream.h>
  34. #include <vlc_es_out.h>
  35.  
  36. /**
  37.  * \defgroup demux Demux
  38.  * @{
  39.  */
  40.  
  41. struct demux_t
  42. {
  43.     VLC_COMMON_MEMBERS
  44.  
  45.     /* Module properties */
  46.     module_t    *p_module;
  47.  
  48.     /* eg informative but needed (we can have access+demux) */
  49.     char        *psz_access;
  50.     char        *psz_demux;
  51.     char        *psz_path;
  52.  
  53.     /* input stream */
  54.     stream_t    *s;     /* NULL in case of a access+demux in one */
  55.  
  56.     /* es output */
  57.     es_out_t    *out;   /* our p_es_out */
  58.  
  59.     /* set by demuxer */
  60.     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
  61.     int (*pf_control)( demux_t *, int i_query, va_list args);
  62.  
  63.     /* Demux has to maintain them uptodate
  64.      * when it is responsible of seekpoint/title */
  65.     struct
  66.     {
  67.         unsigned int i_update;  /* Demux sets them on change,
  68.                                    Input removes them once take into account*/
  69.         /* Seekpoint/Title at demux level */
  70.         int          i_title;       /* idem, start from 0 (could be menu) */
  71.         int          i_seekpoint;   /* idem, start from 0 */
  72.     } info;
  73.     demux_sys_t *p_sys;
  74.  
  75.     /* Weak link to parent input */
  76.     input_thread_t *p_input;
  77. };
  78.  
  79.  
  80. /* demux_meta_t is returned by "meta reader" module to the demuxer */
  81. typedef struct demux_meta_t
  82. {
  83.     VLC_COMMON_MEMBERS
  84.     demux_t *p_demux; /** FIXME: use stream_t instead? */
  85.     input_item_t *p_item; /***< the input item that is being read */
  86.  
  87.     vlc_meta_t *p_meta;                 /**< meta data */
  88.  
  89.     int i_attachments;                  /**< number of attachments */
  90.     input_attachment_t **attachments;    /**< array of attachments */
  91. } demux_meta_t;
  92.  
  93. enum demux_query_e
  94. {
  95.     /* I. Common queries to access_demux and demux */
  96.     /* POSITION double between 0.0 and 1.0 */
  97.     DEMUX_GET_POSITION,         /* arg1= double *       res=    */
  98.     DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
  99.  
  100.     /* LENGTH/TIME in microsecond, 0 if unknown */
  101.     DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
  102.     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
  103.     DEMUX_SET_TIME,             /* arg1= int64_t arg2= bool b_precise   res=can fail    */
  104.  
  105.     /* TITLE_INFO only if more than 1 title or 1 chapter */
  106.     DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int*
  107.                                    arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
  108.     /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
  109.     DEMUX_SET_TITLE,            /* arg1= int            can fail */
  110.     DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
  111.  
  112.     /* DEMUX_SET_GROUP only a hit for demuxer (mainly DVB) to allow not
  113.      * reading everything (you should not use this to call es_out_Control)
  114.      * if you don't know what to do with it, just IGNORE it, it is safe(r)
  115.      * -1 means all group, 0 default group (first es added) */
  116.     DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
  117.  
  118.     /* Ask the demux to demux until the given date at the next pf_demux call
  119.      * but not more (and not less, at the precision available of course).
  120.      * XXX: not mandatory (except for subtitle demux) but I will help a lot
  121.      * for multi-input
  122.      */
  123.     DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t *      can fail */
  124.     /* FPS for correct subtitles handling */
  125.     DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
  126.  
  127.     /* Meta data */
  128.     DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
  129.     DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
  130.  
  131.     /* Attachments */
  132.     DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
  133.  
  134.     /* RECORD you are ensured that it is never called twice with the same state
  135.      * you should accept it only if the stream can be recorded without
  136.      * any modification or header addition. */
  137.     DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
  138.     DEMUX_SET_RECORD_STATE,     /* arg1=bool    res=can fail */
  139.  
  140.  
  141.     /* II. Specific access_demux queries */
  142.     /* PAUSE you are ensured that it is never called twice with the same state */
  143.     DEMUX_CAN_PAUSE = 0x1000,   /* arg1= bool*    can fail (assume false)*/
  144.     DEMUX_SET_PAUSE_STATE,      /* arg1= bool     can fail */
  145.  
  146.     DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
  147.  
  148.     /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
  149.      * data at our pace */
  150.     DEMUX_CAN_CONTROL_PACE,     /* arg1= bool*pb_pace    can fail (assume false) */
  151.  
  152.     /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has returned false.
  153.      * *pb_rate should be true when the rate can be changed (using DEMUX_SET_RATE)
  154.      * *pb_ts_rescale should be true when the timestamps (pts/dts/pcr) have to be rescaled */
  155.     DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
  156.     /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
  157.      * It should return the value really used in *pi_rate */
  158.     DEMUX_SET_RATE,             /* arg1= int*pi_rate                                        can fail */
  159.  
  160.     DEMUX_CAN_SEEK,            /* arg1= bool*    can fail (assume false)*/
  161. };
  162.  
  163. VLC_EXPORT( int,       demux_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int64_t i_bitrate, int i_align, int i_query, va_list args ) );
  164.  
  165. /*************************************************************************
  166.  * Miscellaneous helpers for demuxers
  167.  *************************************************************************/
  168.  
  169. LIBVLC_USED
  170. static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
  171. {
  172.     const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
  173.     if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
  174.         return false;
  175.     return true;
  176. }
  177.  
  178. LIBVLC_USED
  179. static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
  180. {
  181.    if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
  182.         return false;
  183.     return true;
  184. }
  185.  
  186. /**
  187.  * This function will create a packetizer suitable for a demuxer that parses
  188.  * elementary stream.
  189.  *
  190.  * The provided es_format_t will be cleaned on error or by
  191.  * demux_PacketizerDestroy.
  192.  */
  193. VLC_EXPORT( decoder_t *,demux_PacketizerNew, ( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) );
  194.  
  195. /**
  196.  * This function will destroy a packetizer create by demux_PacketizerNew.
  197.  */
  198. VLC_EXPORT( void, demux_PacketizerDestroy, ( decoder_t *p_packetizer ) );
  199.  
  200. /**
  201.  * This function will return the parent input of this demux.
  202.  * It is retained. Can return NULL.
  203.  */
  204. VLC_EXPORT( input_thread_t *, demux_GetParentInput, ( demux_t *p_demux ) );
  205.  
  206. /* */
  207. #define DEMUX_INIT_COMMON() do {            \
  208.     p_demux->pf_control = Control;          \
  209.     p_demux->pf_demux = Demux;              \
  210.     p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
  211.     if( !p_demux->p_sys ) return VLC_ENOMEM;\
  212.     } while(0)
  213.  
  214. /**
  215.  * @}
  216.  */
  217.  
  218. #endif
  219.